API Documentation
Compositor.h
1 // Compositor.h
3 //
5 
6 namespace nkGraphics
7 {
20  class DLL_GRAPHICS_EXPORT Compositor : public nkExport::Exportable
21  {
22  public :
23 
32  Compositor (const Compositor&) = delete ;
36  virtual ~Compositor () ;
37 
43  virtual CompositorNode* addNode () = 0 ;
49  virtual void deleteNode (unsigned int index) ;
57  virtual void changeNodeOrder (unsigned int fromIndex, unsigned int toIndex) ;
61  virtual void clearNodes () ;
62 
66  unsigned int getNodeCount () const ;
71  CompositorNode* getNode (unsigned int index) const ;
72 
81  virtual void renderChain () ;
82 
88  virtual void exportClassToTree (nkExport::Node* rootNode) override ;
94  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
95 
96  // Operators
100  Compositor& operator= (const Compositor&) = delete ;
101  } ;
102 }
nkGraphics::Compositor::Compositor
Compositor()
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkGraphics::Compositor
A compositor, describing how to compose the rendering pipeline.
Definition: Compositor.h:21
nkGraphics::Compositor::changeNodeOrder
virtual void changeNodeOrder(unsigned int fromIndex, unsigned int toIndex)
nkGraphics::Compositor::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkGraphics::Compositor::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode) override
nkGraphics::CompositorNode
A node in the rendering graph described by a Compositor.
Definition: CompositorNode.h:12
nkGraphics::Compositor::getNode
CompositorNode * getNode(unsigned int index) const
nkGraphics::Compositor::getNodeCount
unsigned int getNodeCount() const
nkGraphics::Compositor::~Compositor
virtual ~Compositor()
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkGraphics::Compositor::deleteNode
virtual void deleteNode(unsigned int index)
nkGraphics::Compositor::Compositor
Compositor(const Compositor &)=delete
nkGraphics::Compositor::clearNodes
virtual void clearNodes()
nkGraphics::Compositor::renderChain
virtual void renderChain()
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::Compositor::addNode
virtual CompositorNode * addNode()=0